ModelingRelationship
Relationship definition used in the models when joining across tables columns.
API Section: Objects
Type: Object
Properties
Name |
Description |
Required |
Type |
Format |
---|---|---|---|---|
relationshipId |
The relationship's system ID |
- |
string |
uuid |
columns |
A pair of linked columns used to define a relationship in the model definition. A relationship can be defined by 1 or more pairs. |
- | ||
primaryTableUniqueName |
The primary table's unique name |
- |
string |
|
foreignTableUniqueName |
The foreign table's unique name |
- |
string |
|
type |
The type of join used in relationships of a data model (inner, right outer, left outer, full outer, or cross join) |
- | ||
isBiDirectional |
Boolean indicating if the join is bi-directional |
- |
boolean |